마크다운 포스트 작성법, 작성시 세부 기능들 ✍️

Posted by @harmony, March 04, 2024

1. MarkDown 기반
2. 메타 정보
3. 포스트 내부에 이미지 추가
4. 코드 하이라이트 지원
5. 포스트 미리보기 이미지 (썸네일)
- 5-1. 미리보기 추가
- 5-2. 디폴트 미리보기 이미지 (default.png)
6. Toc (목차)
7. 기능 요약

1. MarkDown 기반

이 템플릿은 Markdown 작성법을 기반으로 합니다. 글 작성을 위해 /src/contents/posts 아래 디렉토리에 포스트를 생성하고 마크다운 형식으로 작성해야 합니다.

예를들어 /src/contents/posts 아래 디렉토리에 how-to-use 라는 디렉토리(폴더)를 생성하고 index.md 파일에 포스트를 작성하면 됩니다. 이 예시의 경우 포스트의 URL 이 http(s)://your-domain/how-to-use 로 지정됩니다.

2. 메타 정보

마크다운 파일을 생성했다면, 해당 포스트에 대한 메타정보를 필수로 기입해야 합니다. 기입 정보는 아래와 같습니다.

---
title: 포스트 작성법, 작성시 세부 기능들
description: 현 템플릿을 어떻게 사용하는지 알아봅시다.
date: "2024-03-02"
tags:
  - Introduce
  - About
series: how to use this template?
// isPrivate: true
---

각 메타 정보에 대한 설명은 다음과 같습니다.

title : 포스트의 제목
description : 포스트에 대한 설명 요약. 생략시
date : 포스팅 날짜
tags : 태그 리스트
series : 시리즈 (카테고리 개념과 유사)
isPrivate : 비공개 여부. (현 포스트에 대해 비공개를 원할시 "isPrivate: true" 를 지정해주세요.)

3. 포스트 내부에 이미지 추가

포스트에 이미지를 추가시, 아래와 같은 형식으로 이미지를 첨부할 수 있습니다. 이미지는 동일한 폴더 내에 (즉, 현재 markdown 파일과 동일한 폴더 안에) 위치해야 한다는 점을 유의해주세요.

![](./이미지 이름)

아래는 image1.png 라는 이름의 이미지를 첨부한 예시입니다.

4. 코드 하이라이트 지원

포스트에 코드 블럭을 생성 가능합니다. 아래는 JAVA 언어를 기반으로 작성된 코드 블럭입니다.

public String getLines(){
  StringBuilder stringBuilder = new StringBuilder();
  repeatPrint(stringBuilder);
  return stringBuilder.toString();
}

private void repeatRows(StringBuilder stringBuilder){
  for(int i=0; i<10; i++){
    repeatRow(stringBuilder);
    stringBuilder.append("two");
  }
}

private void repeatRow(StringBuilder stringBuilder){
  for(int i=0; i<5; i++){
    stringBuilder.append("one");
  }
}